[BETA] Inventory-level Forecasts

Get inventory forecasts for the given inventory items and time window.

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

It returns a list of daily forecasts for the following metrics:

• Total number of auctions.
• Total number of slots.
• Total number of winners.
• Total number of impressions.
• Total number of clicks.
• Average CPC.
• Average CTR.
• Slot occupancy (Proportion of slots that are occupied).
• Total capacity (represents the potential revenue that could be generated under optimal conditions).
• Occupied capacity (reflects the actual revenue generated from effective winners and active campaigns).

POST /public/v1/toptimize/forecasting/inventory

Try it

[BETA] Inventory-level Forecasts

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inventory": [
    {
      "inventoryType": "category",
      "inventoryValue": "<string>"
    }
  ],
  "timeWindow": 7
}
'

200

[
  {
    "inventoryType": "category",
    "inventoryValue": "<string>",
    "dailyForecasts": [
      {
        "forecastDate": "2023-12-25",
        "metrics": [
          {
            "metricName": "<string>",
            "values": {
              "forecastValue": 123,
              "forecastIntervalMin": 123,
              "forecastIntervalMax": 123
            }
          }
        ]
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Body

application/json

Request model for batch inventory forecasts.

inventory · InventoryItem · object[] · required

List of inventory type and value combinations to forecast

Show child attributes

inventory. inventoryType · enum<string> · required

The type of inventory (category or search)

Available options: category, search

inventory. inventoryValue · string · required

The value of the inventory

timeWindow · integer | null · default: 7

Number of days in the future to retrieve forecasts for.

Required range: x >= 1

Response

200

application/json

Successful Response

inventoryType · enum<string> · required

The type of inventory

Available options: category, search

inventoryValue · string · required

The value of the inventory

dailyForecasts · DailyForecast · object[] · required

List of daily forecasts for this inventory

Show child attributes

dailyForecasts. forecastDate · string<date> · required

Date of the forecast

dailyForecasts. metrics · MetricForecast · object[] · required

List of metric forecasts for this date

Show child attributes

dailyForecasts.metrics. metricName · string · required

Name of the metric being forecasted

dailyForecasts.metrics. values · ForecastMetricValue · object · required

Forecast values for this metric

Show child attributes

dailyForecasts.metrics.values. forecastValue · number · required

The forecasted value

dailyForecasts.metrics.values. forecastIntervalMin · number · required

The lower bound of the confidence interval

dailyForecasts.metrics.values. forecastIntervalMax · number · required

The upper bound of the confidence interval